home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / et / etdoc.txt < prev    next >
Text File  |  1991-10-24  |  4KB  |  118 lines
  1. README.ETDOC
  2. ************
  3. Release Notes for ET++ Reference Documentation, ET++ Version 2.2
  4. October 1991 - Thomas Kofler
  5.  
  6. The ET++ reference documentation describes most of the classes of ET++
  7. which are relevant for developing applications with ET++.  The
  8. reference documentation consists of a set standard UNIX manual pages.
  9.  
  10.  
  11. The documentation was produced by CSE, Linz, Austria in collaboration with
  12. UBS/UBILAB.
  13.  
  14. Send comments to:
  15.  
  16.         Andre Weinand
  17.         Union Bank of Switzerland
  18.         UBILAB (Union Bank Informatics Laboratory)
  19.         Bahnhofstrasse 45
  20.         P.O.Box
  21.         CH-8021 Zurich
  22.         Switzerland
  23.  
  24.         phone: +41-1-236-40-53
  25.         fax:   +41-1-236-46-71
  26.         e-mail: weinand@ifi.unizh.ch
  27.  
  28.  
  29. 1.      Installation
  30. --------------------
  31.     
  32. It is assumed that ET++ 2.2 is installed, and its base directory is denoted
  33. here by $ET_DIR. 
  34. (see the files INSTALL and CSHRC files in the ET++ distribution).
  35.  
  36.  
  37. 1. Go the directory $ET_DIR  where ET++ 2.2 is installed, for instance
  38. '/local/et2.2':
  39.     % cd /local/et2.2
  40.     
  41. The path names in the tape tar file are relative, so extract the
  42. distribution files from the tar file on the tape, for instance, using:
  43.     % tar -xvf /dev/rst0
  44.  
  45. 2. The location for the manual page files is:  
  46.     ./man/mann
  47.     
  48. 3. The required disk space for installing the manual pages
  49.    is 1.4 MB
  50.  
  51. 4. Set the environment variable MANPATH either manually or
  52. in your .cshrc file (or .profile file) to:
  53.     :$ET_DIR/man$MANPATH
  54.     
  55.     
  56. If MANPATH does not contain the path to the ET++ manual page files, then the
  57. man option -M can be used to specify the directory. For instance:
  58.     % man -M $ET_DIR/man Object
  59.  
  60.  
  61. 2.      How to use it
  62. ---------------------
  63.        
  64. There is a set of manual pages for each documented class:
  65. -   The class description describes the class as a whole.
  66. -   For each method of a class, there is a method description.
  67.  
  68. Further, there are manual pages for C++ typedefs, enumerations, ET++
  69. macros, global variables and normal functions.
  70.  
  71.     Command                 accesses description of
  72.     -----------------------------------------------
  73.     % man Class             # class and all its methods
  74.     % man Class.short       # class only
  75.     % man Class::Method     # a method      
  76.     % man Class::Class      # all constructors (like normal overloaded methods)
  77.     % man Class::~Class     # destructor
  78.  
  79.     % man function.Function # a function (there are currently none)
  80.         
  81.     % man enum              # all enumeration types
  82.     % man enum.EnumType     # an enumeration type
  83.     % man const             # all (global) constants    
  84.     % man var               # all (global) variables
  85.     % man macro             # all macros 
  86.    
  87. Specifying the name of an overloaded method or
  88. function retrieves the description of all methods with that name.
  89.  
  90.  
  91. 3.      Problems
  92. ----------------
  93.       
  94. 1. The directory for the manual page files must be man/mann.
  95.  
  96. 2. The following commands do not work properly
  97.  
  98.     Command                 should access description of
  99.     ----------------------------------------------------
  100.     % man const.Constant    # a (global) constant 
  101.     % man var.Variable      # a (global) variable
  102.     % man macro.Macro       # a macro
  103.          
  104. Since there is not much material in these categories, print them as a whole
  105. by:
  106.  
  107.     % man -t const
  108.     % man -t var
  109.     % man -t macro
  110.  
  111. 3. The manual page files were generated from a special format called CDF
  112. (Class Description Format). The generator is currently not very clever
  113. and it creates too many individual manual page files.
  114. If you want to print all material, you will get about 1000 pages...
  115.  
  116. 4. An ET++ concepts manual is still missing
  117.  
  118.